home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 7 / Apprentice-Release7.iso / Source Code / C / Applications / Moscow ML 1.42 / lib / Help.sig < prev    next >
Encoding:
Text File  |  1997-08-18  |  1.3 KB  |  40 lines  |  [TEXT/Moml]
  1. (* Help *)
  2.  
  3. val help : string -> unit
  4.  
  5. val displayLines : int ref
  6.  
  7. (* 
  8.    [help s] provides on-line help on the topic indicated by string s.  
  9.  
  10.    help "lib";   gives an overview of the Moscow ML library.
  11.  
  12.    help "id";    provides help on identifier id (case-insensitive).
  13.  
  14.    If exactly one identifier in the library matches id (case-insensitive), 
  15.    then the browser opens the signature defining that identifier, 
  16.    positioning the first occurrence of id at the center of the screen.
  17.  
  18.    If more than one identifier matches id (case-insensitive), then a
  19.    small menu lists the signatures containing the identifier.  To
  20.    invoke the browser, just type in the number of the desired
  21.    signature.
  22.  
  23.    The browser accepts the following commands, which must be followed
  24.    by a newline:
  25.  
  26.       d      move down by half a screen
  27.       u      move up by half a screen
  28.       t      move to top of file
  29.       b      move to bottom of file
  30.       /str   cyclically search for string str in help file (case-insensitive)
  31.       n      search for next occurrence of str
  32.       q      quit the browser
  33.  
  34.    A newline by itself moves down one screen (24 lines).
  35.  
  36.    [displayLines] is a reference to the size of the display (window)
  37.    assumed by the browser; 24 lines by default.  Set to the actual
  38.    size of your window for best results.  
  39. *)
  40.